🛠️ App Services Configuration
App Services enable workflows to respond to HTTP requests without requiring authentication, making them suitable for public or internal APIs that do not need strict security controls. This can simplify integrations where authentication is handled elsewhere or is unnecessary.
Configuration Fields:
-
Name: Enter a clear, descriptive name for the service to distinguish it from other APIs or endpoints.
-
HTTP Method and Basic URL: Select the HTTP method (GET, POST, PUT, DELETE, etc.) and enter the base URL where this service listens for requests.
-
Params: Define parameters to be passed with the request:
- Query Params: Key-value pairs sent in the URL to pass data or filters.
- Path Variables: Dynamic segments of the URL path that accept variable input.
-
Headers: Add any required HTTP headers, such as content types, authentication tokens, or custom metadata, to tailor requests or responses.
-
Body: Configure the content sent in the request body. Supported formats include:
- None
- Form-Data
- Raw (e.g., JSON, XML, plain text)
- Files (for file uploads)
-
Response JSON: Specify the expected response formats and HTTP status codes. This helps handle parsing or validation of API responses.
Example YAML Configuration
app_service:
name: "Public API Endpoint"
method: "GET"
base_url: "https://api.example.com/public/data"
params:
query:
- key: "filter"
value: "active"
description: "Filter for active items"
path_variables: []
headers:
- key: "Content-Type"
value: "application/json"
description: "Request content type"
body: null
response:
status_codes:
- 200
- 404
App Services are ideal for lightweight, fast-responding endpoints that integrate external systems or expose workflow data without complex authentication overhead. They provide a simple way to create APIs that can be consumed internally or by third parties when authentication is not required or is handled externally.